gridpack::component::OptimizationInterface Class Reference

#include <optimization_ifc.hpp>

List of all members.

Public Member Functions
	OptimizationInterface (void)
virtual	~OptimizationInterface (void)
virtual std::vector < boost::shared_ptr < gridpack::optimization::Variable > >	getVariables ()
virtual std::vector < boost::shared_ptr < gridpack::optimization::Variable > >	getAuxVariables ()
virtual boost::shared_ptr < gridpack::optimization::Expression >	getGlobalConstraint (const char *tag)
virtual std::vector < boost::shared_ptr < gridpack::optimization::Constraint > >	getLocalConstraints ()
virtual boost::shared_ptr < gridpack::optimization::Expression >	getObjectiveFunction ()

---

Constructor & Destructor Documentation

gridpack::component::OptimizationInterface::OptimizationInterface

(

void

)

Constructor

virtual gridpack::component::OptimizationInterface::~OptimizationInterface

(

void

)

[virtual]

Destructor

---

Member Function Documentation

virtual std::vector<boost::shared_ptr<gridpack::optimization::Variable> > gridpack::component::OptimizationInterface::getAuxVariables

(

)

[virtual]

Return a vector of auxiliary variables associated with this interface. These are variables that are used in expressions but may not be defined by this network

Returns:

list of variables

virtual boost::shared_ptr<gridpack::optimization::Expression> gridpack::component::OptimizationInterface::getGlobalConstraint

(

const char *

tag

)

[virtual]

Return contribution from bus to a global constraint

Parameters:

tag

string that can be parsed by bus to determine which constraint contribution is being requested

Returns:

contribution to global constraint. If no contribution, return null pointer

virtual std::vector<boost::shared_ptr<gridpack::optimization::Constraint> > gridpack::component::OptimizationInterface::getLocalConstraints

(

)

[virtual]

Return a list of local constraints from component

Returns:

list of constraints

virtual boost::shared_ptr<gridpack::optimization::Expression> gridpack::component::OptimizationInterface::getObjectiveFunction

(

)

[virtual]

Return contribution to objective function

Returns:

expression representing contribution to objective function. If no contribution, return null pointer

virtual std::vector<boost::shared_ptr<gridpack::optimization::Variable> > gridpack::component::OptimizationInterface::getVariables

(

)

[virtual]

Return a vector of optimization variables associated with this interface

Returns:

list of variables

---

The documentation for this class was generated from the following file:

• optimization_ifc.hpp